REST API Macroservice AsyncAPI 1.0.0

AsyncAPI for the REST API macroservice. This service both publishes and subscribes to several events and also exposes Server-Sent Events (SSE) to the frontend (HTTP-based push).

  • #restapi
  • #sse

Servers

  • ${CLOUDAMQP_URL:///amqp://admin:admin@localhost:5672}amqprabbitmq

    RabbitMQ broker (env CLOUDAMQP_URL supported)

Operations

  • PUB StalkingAnalyzeRequestedEvent

    Queue published when a stalking analysis is requested (service publishes).

    Publish request to start stalking analysis

    Operation IDpublishStalkingAnalyzeRequested

    Available only on servers:

    Accepts the following message:

    StalkingAnalyzeRequested

    Request to start stalking analysis for given social URLs.

    Message IDStalkingAnalyzeRequested
    object

    Examples

  • PUB ChatStartInterviewEvent

    Queue published when chat interview starts (service publishes).

    Publish start of chat interview

    Operation IDpublishChatStartInterview

    Available only on servers:

    Accepts the following message:

    ChatStartInterview

    Start of the chat interview flow.

    Message IDChatStartInterview
    object

    Examples

  • PUB ChatUserAnsweredEvent

    Queue published when user answers in chat (service publishes).

    Publish user's chat answer

    Operation IDpublishChatUserAnswered

    Available only on servers:

    Accepts the following message:

    ChatUserAnswered

    User answered during chat interview.

    Message IDChatUserAnswered
    object

    Examples

  • PUB GiftGenerateRequestedEvent

    Queue published to request gift generation (service publishes).

    Publish request to generate gift ideas

    Operation IDpublishGiftGenerateRequested

    Available only on servers:

    Accepts the following message:

    GiftGenerateRequested

    Request to generate gift ideas.

    Message IDGiftGenerateRequested
    object

    Examples

  • SUB StalkingCompletedEvent

    Queue the service subscribes to when stalking is completed.

    Consume stalking completed events

    Operation IDhandleStalkingCompleted

    Available only on servers:

    Accepts the following message:

    StalkingCompleted

    Stalking analysis completed with extracted keywords.

    Message IDStalkingCompleted
    object

    Examples

  • SUB ChatQuestionAskedEvent

    Queue the service subscribes to for question asked notifications.

    Consume chat question asked

    Operation IDhandleChatQuestionAsked

    Available only on servers:

    Accepts the following message:

    ChatQuestionAsked

    Question asked by the user during chat.

    Message IDChatQuestionAsked
    object

    Examples

  • SUB ChatInterviewCompletedEvent

    Queue the service subscribes to for interview completion.

    Consume chat interview completed

    Operation IDhandleChatInterviewCompleted

    Available only on servers:

    Accepts the following message:

    ChatInterviewCompleted

    Interview flow finished with computed profile.

    Message IDChatInterviewCompleted
    object

    Examples

  • SUB GiftReadyEvent

    Queue the service subscribes to to receive generated gift ideas.

    Consume generated gift ideas

    Operation IDhandleGiftReady

    Available only on servers:

    Accepts the following message:

    GiftReady

    Generated gift ideas ready to consume.

    Message IDGiftReady
    object

    Examples

  • SUB ChatInappropriateRequestEvent

    Queue the service subscribes to for inappropriate requests.

    Consume inappropriate requests

    Operation IDhandleChatInappropriateRequest

    Available only on servers:

    Accepts the following message:

    ChatInappropriateRequest

    The request was flagged as inappropriate.

    Message IDChatInappropriateRequest
    object

    Examples

Messages

  • #1StalkingAnalyzeRequested

    Request to start stalking analysis for given social URLs.

    Message IDStalkingAnalyzeRequested
    object
  • #2ChatStartInterview

    Start of the chat interview flow.

    Message IDChatStartInterview
    object
  • #3ChatUserAnswered

    User answered during chat interview.

    Message IDChatUserAnswered
    object
  • #4GiftGenerateRequested

    Request to generate gift ideas.

    Message IDGiftGenerateRequested
    object
  • #5StalkingCompleted

    Stalking analysis completed with extracted keywords.

    Message IDStalkingCompleted
    object
  • #6ChatQuestionAsked

    Question asked by the user during chat.

    Message IDChatQuestionAsked
    object
  • #7ChatInterviewCompleted

    Interview flow finished with computed profile.

    Message IDChatInterviewCompleted
    object
  • #8GiftReady

    Generated gift ideas ready to consume.

    Message IDGiftReady
    object
  • #9ChatInappropriateRequest

    The request was flagged as inappropriate.

    Message IDChatInappropriateRequest
    object